Get FCM Topic List

📝 Overview

The GetFCMTopicList API retrieves FCM topics created through the web admin panel. Users subscribed to these topics will receive corresponding push notifications.
This API is required when sending recommendations.

🔗 Endpoint

Method	URL
GET	<protocol>://<host name>:<service port>/<service name>/<tenantid>/v1/GetFCMTopicList

Request

📥 Parameters

Parameter	Data Type	Mandatory / Optional	Description
sessionKey	string	Mandatory	Session key received from AuthenticateKeys API. Must be passed as Bearer Authorization Header.

Example Request Headers

{
  "Authorization": "Bearer eyBDyGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJDdXN0b21lcklkIjoiMTUyMyIsIm5Ob2RlTGljZW5zZUV4cGlyeSI6IjE4OTM2MDkwMDAiLCJpYXQiOjE1NjM2MDI2Nzd9.oRVgIlN3K_m5AXh_K1M88exzBg96CYJEVo_LQ-YZ6Yd"
}

Response

The ResponseObject contains the following parameters in a JSON structure:

📦 Response Parameters

Parameter (Key)	Data Type	Description
status	boolean	Indicates the status of the request. true if the response is successful, false if an error occurred.
errorCode	string	Error code if any error occurred.
errorString	string	Error description.
nTopicNo	int	Topic number used in the Send Scrip Recommendation API.
sTopicName	string	Topic name is used in the Send Scrip Recommendation API. Recommendation should be published with one of this topic and users who subscribed to that topics will receive push notifications.
sTopicDisplayName	string	User-readable topic name.

Example Response

{
  "status": true,
  "errorCode": "",
  "errorString": "",
  "systemTopics": [
    {
      "nTopicNo": "1",
      "sTopicName": "all",
      "sTopicDisplayName": "All Users (System Defined)"
    },
    {
      "nTopicNo": "2",
      "sTopicName": "android",
      "sTopicDisplayName": "Android (System Defined)"
    },
    {
      "nTopicNo": "3",
      "sTopicName": "ios",
      "sTopicDisplayName": "Ios (System Defined)"
    },
    {
      "nTopicNo": "4",
      "sTopicName": "registered",
      "sTopicDisplayName": "Registered (System Defined)"
    },
    {
      "nTopicNo": "5",
      "sTopicName": "guest",
      "sTopicDisplayName": "Guest (System Defined)"
    }
  ],
  "adminTopics": [
    {
      "nTopicNo": "6",
      "sTopicName": "intraday",
      "sTopicDisplayName": "Intraday Calls"
    },
    {
      "nTopicNo": "7",
      "sTopicName": "derivatives",
      "sTopicDisplayName": "Derivatives Calls"
    }
  ]
}